Using Help | Contents | Index | Site Map | Search

Using Help

Viewing topics

Using the Contents

Using the Index

Using the Site Map

Using Search

Web browser requirements

Accessibility features of Help


Contents

Overview

About this Guide

After Effects objects

What about expressions and motion math?

What you should know

Activating full scripting features

Activating the JavaScript Debugger

Accessing and writing scripts

Recordable actions and scripts

Uses of After Effects scripting

Writing Scripts

Projects and objects

The Scripts menu, folder & editing scripts

The Scripts folder & menu

Shutdown & Startup

To include After Effects scripting in a command line (Windows only):

Testing and troubleshooting

More resources to learn scripting

JavaScript Debugging

The JavaScript Debugger window

Controlling Code Execution in the Script Debugger Window

Using the JavaScript command line entry field

Command line entry field

Setting Breakpoints

Setting Breakpoints in the Script Debugger Window

Setting Breakpoints in JavaScript Code

Script Breakpoints Window

Setting Breakpoints in the Script Breakpoints Window

The Debugger Object ($)

Debug output

Other Methods

Reference

Introduction

ECMAScript Language Specification

Keywords and statement syntax

Operators

Reference for Objects, Methods, Attributes, and Globals

Global Functions

alert() Global Function

Application Object

Application beginUndoGroup() Method

Application endUndoGroup() Method

Application endWatchFolder() Method

Application exitCode Attribute

Application isProfessionalVersion Attribute

Application isRenderEngine Attribute

Application isWatchFolder Attribute

Application language Attribute

Application newProject() Method

Application onError Attribute

Application open() Method

Application pauseWatchFolder() Method

Application purge() Method

Application registeredCompany Attribute

Application registeredName Attribute

Application serialNumber Attribute

Application quit() Method

Application watchFolder() Method

Application version Attribute

AVItem Object

clearOutput() Global Function

Collection Object

CompItem Object

CompItem frameDuration Attribute

CompItem workAreaDuration Attribute

CompItem workAreaStart Attribute

confirm() Global Function

File Class

File() Class Method

File Object

File close() Method

File copy() Method

File creator Attribute

File encoding Attribute

File eof Attribute

File hidden Attribute

File length Attribute

File lineFeed Attribute

File open() Method

File openDialog() Class Method

File read() Method

File readch() Method

File readln() Method

File readonly Attribute

File saveDialog() Class Method

File seek() Method

File tell() Method

File type Attribute

File write() Method

File writeln() Method

fileGetDialog() Global Function

filePutDialog() Global Function

FileSystem Class

FileSystem Object

FileSystem absoluteURI Attribute

FileSystem alias Attribute

FileSystem created Attribute

FileSystem decode() Class Method

FileSystem encode() Class Method

FileSystem error Attribute

FileSystem exists Attribute

FileSystem fs Class Attribute

FileSystem fsName Attribute

FileSystem getRelativeURI() Method

FileSystem modified Attribute

FileSystem name Attribute

FileSystem parent Attribute

FileSystem path Attribute

FileSystem relativeURI Attribute

FileSystem remove() Method

FileSystem rename() Method

FileSystem resolve() Method

Folder Class

Folder Object

Folder() Class Method

Folder create() Method

Folder current Class Attribute

Folder getFiles() Method

Folder selectDialog() Class Method

Folder startup Class Attribute

Folder system Class Attribute

Folder temp Class Attribute

Folder trash Class Attribute

folderGetDialog() Global Function

FolderItem Object

FootageItem Object

FootageItem file Attribute

FootageItem replace() Method

FootageItem replaceWithSequence() Method

ImportOptions Object

ImportOptions canImportAs() Method

ImportOptions forceAlphabetical Attribute

ImportOptions importAs Attribute

ImportOptions sequence Attribute

Item Collection

Item Object

Item name Attribute

OutputModule Object

OutputModule Collection

OutputModule applyTemplate() Method

OutputModule file Attribute

OutputModule name Attribute

OutputModule postRenderAction Attribute

OutputModule remove() Method

OutputModule saveAsTemplate() Method

OutputModule templates Attribute

Project Object

Project activeItem Attribute

Project bitsPerChannel Attribute

Project close() Method

Project consolidateFootage() Method

Project file Attribute

Project importFile() Method

Project importPlaceholder() Method

Project importFileWithDialog() Method

Project numItems Attribute

Project reduceProject() Method

Project removeUnusedFootage() Method

Project rootFolder Attribute

Project save() Method

Project selection Attribute

Project timecodeBaseType Attribute

Project timecodeDisplayType Attribute

Project timecodeFilmType Attribute

Project timecodeNTSCDropFrame Attribute

Project transparencyGridThumbnails Attribute

prompt() Global Function

RenderQueue Object

RenderQueue items Attribute

RenderQueue numItems Attribute

RenderQueue pauseRendering() Method

RenderQueue render() Method

RenderQueue rendering Attribute

RenderQueue showWindow() Method

RenderQueue stopRendering() Method

RenderQueueItem Collection

RenderQueueItem Object

RenderQueueItem applyTemplate() Method

RenderQueueItem comp Attribute

RenderQueueItem elapsedSeconds Attribute

RenderQueueItem logType Attribute

RenderQueueItem numOutputModules Attribute

RenderQueueItem onStatusChanged Attribute

RenderQueueItem outputModules Attribute

RenderQueueItem remove() Method

RenderQueueItem render Attribute

RenderQueueItem saveAsTemplate() Method

RenderQueueItem startTime Attribute

RenderQueueItem status Attribute

RenderQueueItem templates Attribute

RenderQueueItem timeSpanDuration Attribute

RenderQueueItem timeSpanStart Attribute

Settings Object

Settings getSetting() Method

Settings haveSetting() Method

Settings saveSetting() Method

System Object

System machineName Attribute

System osName Attribute

System osVersion Attribute

System userName Attribute

write() Global Function

writeLn() Global Function

Examples

About the scripts included with After Effects

Save and increment

Render named items

New render locations

Smart Import

Render and Mail

Email Methods

Email Setup

Dialogs and Console

File Fun

The Socket Object

Introduction

JavaScript Reference

Chat server sample

Encoding Names

Supported encoding names

Additional encodings

Common encoding names

Additional Windows encoding names

Additional Macintosh encoding names

Legal Notices

Copyright


Index

A

accessing and writing scripts [1]

activating

full scripting features [1]
JavaScript Debugger [1]

After Effects objects [1]

Application Object [1]

Attributes, reference for [1]

B

breakpoints

Script Breakpoints Window [1]
setting [1]
setting in JavaScript code [1]
setting in the Script Breakpoints Window [1]
setting in the Script Debugger Window [1]

C

Chat server sample [1]

code execution

controlling in the Script Debugger Window [1]

Command line entry field [1]

Common encoding names [1]

Console [1]

D

Debugger Object ($) [1]

Dialogs [1]

E

ECMAScript Language Specification [1]

email Methods [1]

email Setup [1]

encoding names, supported [1]

encodings

additional [1]
additional Macintosh encoding names [1]
additional Windows encoding names [1]

expressions and motion math [1]

F

File Fun script [1]

G

Global Functions [1]

Globals, reference for [1]

J

JavaScript command line entry field, using [1]

JavaScript Debugger window

about [1]
activating [1]

JavaScript Reference [1]

K

Keywords syntax [1]

L

learning resources

additional [1]
what you should know [1]

M

Methods,reference for [1]

N

New render locations script [1]

O

Objects

After Effects [1]
Application [1]
reference for [1]

Operators [1]

R

recordable actions and scripts [1]

reference for Objects, Methods, Attributes, and Globals [1]

Render and Mail [1]

Render named items script [1]

resources to learn scripting [1]

S

sample, Chat Server [1]

Save and increment [1]

Script Breakpoints Window [1]

scripting

what you should know [1]

scripting, uses of [1]

Scripts folder and menu [1]

scripts included with After Effects [1]

setting

breakpoints [1]
breakpoints in JavaScript code [1]
breakpoints in the Script Breakpoints Window [1]
breakpoints in the Script Debugger Window [1]

shutdown [1]

Smart Import [1]

startup [1]

statement syntax [1]

supported encoding names [1]

T

testing and troubleshooting [1]

U

Uses of After Effects scripting [1]